Skip to content

docs: Clarify FunctionalDependence::nullable and Dependency mode docs#23635

Open
alamb wants to merge 1 commit into
apache:mainfrom
alamb:fd-nullable-docs
Open

docs: Clarify FunctionalDependence::nullable and Dependency mode docs#23635
alamb wants to merge 1 commit into
apache:mainfrom
alamb:fd-nullable-docs

Conversation

@alamb

@alamb alamb commented Jul 16, 2026

Copy link
Copy Markdown
Contributor

Which issue does this PR close?

Rationale for this change

While working on #23548 / #23634 I found the existing comments on FunctionalDependence::nullable easy to misread: "whether the source columns can receive NULL values" suggests the flag tracks field nullability, when what all consumers actually rely on is whether the same NULL-containing key may occur in multiple rows (the SQL UNIQUE semantic, where NULLs compare distinct).

What changes are included in this PR?

Comment-only changes to datafusion/common/src/functional_dependencies.rs:

Are these changes tested?

No code changes; covered by existing tests.

Are there any user-facing changes?

No behavior changes; improved rustdoc on public items.

… docs

Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
@github-actions github-actions Bot added the common Related to common crate label Jul 16, 2026
@codecov-commenter

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.
⚠️ Please upload report for BASE (main@a287c0a). Learn more about missing BASE report.

Additional details and impacted files
@@           Coverage Diff           @@
##             main   #23635   +/-   ##
=======================================
  Coverage        ?   80.65%           
=======================================
  Files           ?     1086           
  Lines           ?   366097           
  Branches        ?   366097           
=======================================
  Hits            ?   295268           
  Misses          ?    53236           
  Partials        ?    17593           

☔ View full report in Codecov by Harness.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
  • 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

@alamb alamb changed the title minor: Clarify FunctionalDependence::nullable and Dependency mode docs docs: Clarify FunctionalDependence::nullable and Dependency mode docs Jul 16, 2026
@alamb alamb added the documentation Improvements or additions to documentation label Jul 16, 2026
@alamb
alamb marked this pull request as ready for review July 16, 2026 11:44
@alamb

alamb commented Jul 16, 2026

Copy link
Copy Markdown
Contributor Author

@mustafasrepo / @akurmustafa as the original author of these structures, I wonder if you might have some time to review some comment improvements?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

common Related to common crate documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants